[DON'T MERGE - TESTING] Add Artifacts Section to Swagger Documentation - #2
[DON'T MERGE - TESTING] Add Artifacts Section to Swagger Documentation#2epamLDadayan wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request adds comprehensive Swagger documentation for the Artifacts API, documenting seven key endpoints for managing artifacts and buckets. The documentation introduces a new parameter configuration_title to replace the deprecated integration_id and is_local parameters.
- Adds OpenAPI 3.0 specification for Artifacts API endpoints
- Documents CRUD operations for both artifacts and buckets
- Replaces deprecated parameters with
configuration_titlequery parameter
Comments suppressed due to low confidence (1)
swagger.yaml:157
- Parameter name 'filename' is inconsistent with 'file_name' used in the GET artifact endpoint (line 68). Use consistent naming convention throughout the API.
- name: filename
| /artifacts/artifacts/default/{project_id}/{bucket_name}: | ||
| delete: | ||
| summary: Delete Artifacts | ||
| parameters: | ||
| - name: project_id | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: bucket_name | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: configuration_title | ||
| in: query | ||
| required: false | ||
| schema: | ||
| type: string | ||
| responses: | ||
| '204': | ||
| description: Artifacts deleted successfully |
There was a problem hiding this comment.
This path is identical to line 7, creating a duplicate endpoint definition. The DELETE operation should be merged with the existing GET and POST operations under the same path.
| /artifacts/artifacts/default/{project_id}/{bucket_name}: | |
| delete: | |
| summary: Delete Artifacts | |
| parameters: | |
| - name: project_id | |
| in: path | |
| required: true | |
| schema: | |
| type: string | |
| - name: bucket_name | |
| in: path | |
| required: true | |
| schema: | |
| type: string | |
| - name: configuration_title | |
| in: query | |
| required: false | |
| schema: | |
| type: string | |
| responses: | |
| '204': | |
| description: Artifacts deleted successfully | |
| # (Remove lines 116–137 entirely) |
| responses: | ||
| '204': | ||
| description: Artifacts deleted successfully | ||
| /artifacts/artifact/default/{project_id}/{bucket_name}: |
There was a problem hiding this comment.
The DELETE artifact endpoint path is missing the {file_name} path parameter that exists in the GET artifact endpoint (line 54). This creates an inconsistent API design where deletion requires filename as a query parameter instead of a path parameter.
| /artifacts/artifact/default/{project_id}/{bucket_name}: | |
| /artifacts/artifact/default/{project_id}/{bucket_name}/{file_name}: |
epamLDadayan
changed the title
Summary
This pull request adds the "Artifacts" section to the Swagger documentation. The following endpoints have been documented:
Changes
integration_idandis_localwithconfiguration_titlewhere applicable.Notes
releasebranch and should be merged back into it.Breaking Changes
integration_idandis_localhave been removed and replaced withconfiguration_title.